Add a PR template and issue template #394
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #394 +/- ##
=======================================
Coverage 78.94% 78.94%
=======================================
Files 52 52
Lines 10756 10756
Branches 10756 10756
=======================================
Hits 8491 8491
Misses 1796 1796
Partials 469 469 ☔ View full report in Codecov by Sentry. |
OussamaSaoudi-db
changed the title
nicklan
requested changes
Oct 15, 2024
zachschuermann
requested changes
Oct 15, 2024
|
Also can we make the 'user-facing changes' section of the PR description hidden by default with a comment that says 'uncomment if user-facing changes'? that way we don't just have tons of PRs with 'user-facing changes?' 'No.' |
Co-authored-by: Nick Lanham <[email protected]> Co-authored-by: Zach Schuermann <[email protected]>
Co-authored-by: Zach Schuermann <[email protected]>
zachschuermann
approved these changes
Oct 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
This PR adds a pull request template and issues template to the repository.
The issues template is adapted from Apache Datafusion's issue template: https://github.com/apache/datafusion/.
This pull request template is adapted from Apache Spark's pull request template: https://github.com/apache/spark
Why are the changes needed?
A pull request template encourages open source contributions to clearly state their purpose and approach. It explicitly calls out user facing changes and explains why they are needed. It also encourages all contributions to be well tested. In the event testing was difficult or impossible, this exposes testing pain points can be addressed.
Issues template encourages community members and users to give all the details that would help bugs get fixed and feature requests implemented. Requiring more details from issues also helps newcomers to the project get more context to get started contributing.
Does this PR introduce any user-facing change?
No
How was this change tested?
No way to test pull request templates or issue templates.